bplist-parser

What is bplist-parser?

The bplist-parser npm package is designed for parsing binary property list (plist) files. These files are often used in macOS and iOS for storing settings and properties of applications. The package allows developers to easily read and manipulate data stored in this binary format, making it useful for tasks such as configuration management, application development, and data analysis.

What are bplist-parser's main functionalities?

Parsing binary plist files

This feature allows you to parse binary plist files. The code sample demonstrates how to read a binary plist file from the filesystem and parse it into a JavaScript object using the bplist-parser package.

const bplistParser = require('bplist-parser');
const fs = require('fs');

fs.readFile('/path/to/file.plist', (err, data) => {
  if (err) throw err;
  bplistParser.parseBuffer(data).then((obj) => {
    console.log(obj);
  });
});

Other packages similar to bplist-parser

plist

The plist package provides functionality for parsing and building plist files. It supports both XML and binary plist formats. Compared to bplist-parser, plist offers a broader scope by also allowing the creation of plist files, not just parsing.

simple-plist

Simple-plist is another package that can read and write plist files in both binary and XML formats. It aims to provide a simpler API compared to the plist package. While bplist-parser focuses solely on parsing binary plist files, simple-plist offers both parsing and writing capabilities, making it a more versatile option for working with plist files.

README

bplist-parser

Binary Mac OS X Plist (property list) parser.

Installation

$ npm install bplist-parser

Quick Examples

const bplist = require('bplist-parser');

(async () => {

  const obj = await bplist.parseFile('myPlist.bplist');

  console.log(JSON.stringify(obj));

})();

License

(The MIT License)

Copyright (c) 2012 Near Infinity Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.